---
id: OrderAmended
name: Order amended
version: 0.0.1
summary: |
  Indicates an order has been changed
owners:
  - order-management
badges:
  - content: Recently updated!
    backgroundColor: green
    textColor: green
  - content: 'Broker:Apache Kafka'
    backgroundColor: yellow
    textColor: yellow
    icon: kafka
schemaPath: schema.avro
draft:
  title: In draft awaiting feedback
  message: >
    ### Use with caution, still in draft

    This event is still in draft. It is not yet ready for production. We are
    still working on it and collecting feedback from the team.

    If you would like to provide feedback, please contact us at
    [feedback@eventcatalog.io](mailto:feedback@eventcatalog.io) or our slack
    channel [Order
    Management](https://join.slack.com/t/eventcatalog/shared_invite/zt-1q900000000000000000000000000000).


    If you are looking for a similar event, you can still use the
    [OrderConfirmed](/docs/events/OrderConfirmed/0.0.1) event, until it is
    deprecated.


    If you want to use this event in lower environments, you can. We are looking
    for feedback on the event and how it is used in the team.
---

import Footer from '@catalog/components/footer.astro';

## Overview

The OrderAmended event is triggered whenever an existing order is modified. This event ensures that all relevant services are notified of changes to an order, such as updates to order items, quantities, shipping information, or status. The event allows the system to maintain consistency and ensure that all dependent services can react appropriately to the amendments.

<NodeGraph />

## Example payload

```json title="Example Payload"
{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "amendedItems": [
    {
      "productId": "789e1234-b56c-78d9-e012-3456789fghij",
      "productName": "Example Product",
      "oldQuantity": 2,
      "newQuantity": 3,
      "unitPrice": 29.99,
      "totalPrice": 89.97
    }
  ],
  "orderStatus": "confirmed",
  "totalAmount": 150.75,
  "timestamp": "2024-07-04T14:48:00Z"
}
```

## Schema (Avro)s

<SchemaViewer file="schema.avro" />

## Schema (JSON)

<SchemaViewer file="schema.json" />

<Footer />
